﻿//////////////////////////////////////////////////////////////////////////////
//
//  Copyright © 1998-2024 Glodon Company Limited.  All rights reserved.
//
//  Use of this software is subject to the terms of the Glodon license
//  agreement provided at the time of installation or download, or which
//  otherwise accompanies this software in either electronic or hard copy form.  
//
//////////////////////////////////////////////////////////////////////////////

// NotReviewedButNeeded

#pragma once
#include "GcmpUiInterface.h"
#include "IEventArgs.h"
#include "Any.h"
#include <string>

namespace gcmp
{
    class IAction;
    class CommandParameters;

    class GCMP_UI_INTERFACE_EXPORT IPropertyPanelEventArgs : public IEventArgs
    {
    public:
        /// \brief 析构函数
        virtual ~IPropertyPanelEventArgs() {}

        /// \brief 得到PropertyPanel事件类型
        ///
        /// \notes 当前内置的事件类型如下：
        //
        ///      1. L"ComponentTypeSelectChanged"  构件类型发生改变
        ///      2. L"ComponentTypeModified"       当前构件类型被修改
        ///      3. L"PropertyItemButtonClicked"   属性项目按钮被点击
        ///
        /// \return std::wstring 当前PropertyPanel事件类型 
        virtual const std::wstring& GetType() const = 0;

        /// \brief 得到Property属性项Id(修改属性项时有效)
        virtual void SetPropertyItemUniqueId(const std::wstring &uniqueID) = 0;

        /// \brief 设置Property属性项Id(修改属性项时有效)
        virtual std::wstring GetPropertyItemUniqueId() const = 0;

        /// \brief 得到用户操作产生的新值
        ///
        /// \return 用户操作产生的新值 
        virtual const std::wstring& GetNewValue() const = 0; 
    };
}

